Release 10.1A: OpenEdge Development:
Messaging and ESB

endOfStream function

Returns TRUE if the application retrieved the last text segment, the last item of a stream, or the last byte segment.

Syntax

FUNCTION endOfStream RETURNS LOGICAL.

Applies to

Message objects

Notes

An application should not call the endOfStream function if it used the getMEMPTR function for extracting the data.
The endOfStream function is also used with the TextMessage, StreamMessage, and BytesMessage message types.

See also

createTextMessage procedure, setText procedure, setLongText procedure, appendText procedure, endOfStream function, getCharCount function, getText function, getTextSegment function, getLongText function, getLongTextCP function

For more information, see the "TextMessage" section.

createBytesMessage procedure, setMemptr procedure, writeBoolean procedure, writeByte procedure, writeBytesFromRaw procedure, writeChar procedure, writeDate procedure, writeDateTime procedure, writeDateTime-TZ procedure, writeDouble procedure, writeFloat procedure, writeInt procedure, writeLong procedure, writeLongString procedure, writeShort procedure, writeString procedure, getBytesCount function, endOfStream function, moveToNext procedure, readBytesToRaw procedure, readChar function, readDate function, readDateTime function, readDateTime-TZ function, readDecimal function, readInt function, readLogical function, readLongString function, readLongStringCP function, getMEMPTR function

For more information, see the "BytesMessage" section.

For an example, see the "Publishing, subscribing, and receiving an XML document in a BytesMessage" section.

createStreamMessage procedure, writeBoolean procedure, writeByte procedure, writeBytesFromRaw procedure, writeChar procedure, writeDate procedure, writeDateTime procedure, writeDateTime-TZ procedure, writeDouble procedure, writeFloat procedure, writeInt procedure, writeLong procedure, writeLongString procedure, writeShort procedure, writeString procedure, endOfStream function, moveToNext procedure, readBytesToRaw procedure, readChar function, readDate function, readDateTime function, readDateTime-TZ function, readDecimal function, readInt function, readLogical function, readLongString function, readLongStringCP function

For more information, see the "StreamMessage" section.